<HTML>
  <HEAD>
    <TITLE>threadpool Documentation</TITLE>
    <LINK HREF="threadpool.css" REL="stylesheet" TYPE="text/css">
  </HEAD>
  <BODY BGCOLOR="#FFFFFF">

    <DIV CLASS="qindex">
      <TABLE BORDER="0" WIDTH="100%">
        <TR>

          <TD ALIGN="LEFT">
            <B>threadpool</B>
          </TD>
          <TD ALIGN="RIGHT">
            <A CLASS="qindex" HREF="../index.html">Overview</A> |
            <A CLASS="qindex" HREF="../reference/annotated.html">Reference</A> |
            <A CLASS="qindex" HREF="../tutorial/intro.html">Tutorial</A> |
            <A CLASS="qindex" HREF="../examples/intro.html">Examples</A> |
            <A CLASS="qindex" HREF="../design/intro.html">Design</A>
          </TD>

        </TR>
      </TABLE>
    </DIV>
    <DIV CLASS="qindex">
      <TABLE BORDER="0" WIDTH="100%">
        <TR>
          <TD ALIGN="LEFT">
            <B>Reference</B>
          </TD>
          <TD ALIGN="RIGHT">
            <A CLASS="qindex" HREF="annotated.html">Class List</A> |
            <A CLASS="qindex" HREF="functions.html">Member Functions</A> |
            <A CLASS="qindex" HREF="namespacemembers.html">Typedefs</A> |
            <A CLASS="qindex" HREF="files.html">File List</A>
          </TD>
        </TR>
      </TABLE>
    </DIV>
<!-- Generated by Doxygen 1.6.1 -->
  <div class="navpath"><a class="el" href="a00022.html">boost</a>::<a class="el" href="a00023.html">threadpool</a>::<a class="el" href="a00006.html">looped_task_func</a>
  </div>
<div class="contents">
<h1>boost::threadpool::looped_task_func Class Reference</h1><!-- doxytag: class="boost::threadpool::looped_task_func" -->
<p>Looped task function object.  
<a href="#_details">More...</a></p>

<p><a href="a00029.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00006.html#a0de81e4d23aed52a73fe5ee2d11deaf6">result_type</a></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00006.html#a46f85a3e3bbde3eaf0e2a186dfbd6e16">looped_task_func</a> (function0&lt; bool &gt; const &amp;function, unsigned int const interval=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00006.html#aab9445cd9c082d77c56eee21175f3133">operator()</a> (void) const </td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Looped task function object. </p>
<p>This function object wraps a boolean thread function object. The wrapped task function is invoked by calling the operator () and it is executed in regular time intervals until false is returned. The interval length may be zero. Please note that a pool's thread is engaged as long as the task is looped. </p>

<p>Definition at line <a class="el" href="a00021_source.html#l00107">107</a> of file <a class="el" href="a00021_source.html">task_adaptors.hpp</a>.</p>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a0de81e4d23aed52a73fe5ee2d11deaf6"></a><!-- doxytag: member="boost::threadpool::looped_task_func::result_type" ref="a0de81e4d23aed52a73fe5ee2d11deaf6" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void <a class="el" href="a00006.html#a0de81e4d23aed52a73fe5ee2d11deaf6">boost::threadpool::looped_task_func::result_type</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Indicates the functor's result type. </p>

<p>Definition at line <a class="el" href="a00021_source.html#l00115">115</a> of file <a class="el" href="a00021_source.html">task_adaptors.hpp</a>.</p>

</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a46f85a3e3bbde3eaf0e2a186dfbd6e16"></a><!-- doxytag: member="boost::threadpool::looped_task_func::looped_task_func" ref="a46f85a3e3bbde3eaf0e2a186dfbd6e16" args="(function0&lt; bool &gt; const &amp;function, unsigned int const interval=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">boost::threadpool::looped_task_func::looped_task_func </td>
          <td>(</td>
          <td class="paramtype">function0&lt; bool &gt; const &amp;&nbsp;</td>
          <td class="paramname"> <em>function</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int const &nbsp;</td>
          <td class="paramname"> <em>interval</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>function</em>&nbsp;</td><td>The task's function object which is looped until false is returned. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>interval</em>&nbsp;</td><td>The minimum break time in milli seconds before the first execution of the task function and between the following ones. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="a00021_source.html#l00122">122</a> of file <a class="el" href="a00021_source.html">task_adaptors.hpp</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aab9445cd9c082d77c56eee21175f3133"></a><!-- doxytag: member="boost::threadpool::looped_task_func::operator()" ref="aab9445cd9c082d77c56eee21175f3133" args="(void) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void boost::threadpool::looped_task_func::operator() </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Executes the task function. </p>

<p>Definition at line <a class="el" href="a00021_source.html#l00131">131</a> of file <a class="el" href="a00021_source.html">task_adaptors.hpp</a>.</p>

</div>
</div>
</div>
    <BR>
    <DIV CLASS="qindex">
      <TABLE BORDER="0" WIDTH="100%">
        <TR>
		  <TD CLASS="tiny" ALIGN="LEFT">Copyright &copy 2005-2008 Philipp Henkel</TD>
          <TD ALIGN="RIGHT">
            <A CLASS="qindex" HREF="../index.html">Overview</A> |
            <A CLASS="qindex" HREF="../reference/annotated.html">Reference</A> |
            <A CLASS="qindex" HREF="../tutorial/intro.html">Tutorial</A> |
            <A CLASS="qindex" HREF="../examples/intro.html">Examples</A> |
            <A CLASS="qindex" HREF="../design/intro.html">Design</A>
          </TD>
        </TR>       
      </TABLE>
    </DIV>  
  </BODY>
</HTML>
